DELETE (REST)
(Web Mining)
Synopsis
Sends a DELETE http request to a REST service as is used in CRUD operations to remove an existing resource at a specific URI.Description
This operator can send DELETE requests to REST services. It will return text as a document.
For submitting data, you can either submit a document input, or manually entered JSON or XML via parameter. Note that for most DELETE requests, body is required, so both the input and the parameter can be left empty. In either case, macros within the input will be resolved before it is submitted to the REST service.
By default, if a web service returns an error in the 4xx or 5xx range, this operator will fail. Sometimes however, some requests may be expected to fail, but the process should still continue (and for example return the error in the output document). In those cases, deselect the fail_on_endpoint_error parameter to keep the process going.
Differentiation
GET (REST)
Sends a GET request to a REST service. This is mostly used to download a resource.
PATCH (REST)
Sends a PATCH request to a REST service. This is mostly used to update parts of an existing resource.
POST (REST)
Sends a POST request to a REST service. This is mostly used to create a new resource.
PUT (REST)
Sends a PUT request to a REST service. This is mostly used to replace an existing resource or put a resource at a specific location.
Input
request (IOObject)The optional input port expecting a document. This port does not need an input. Either the request json or request xml parameter will be used (if set), or no request body will be sent along the DELETE request.
Output
- response (IOObject)
The output port returning a document.
Parameters
- request urlThe REST service URL which the operator should call.
- request body typeWhether the request body to the REST service should be JSON or XML. This parameter determines the expected input data of this operator (document or file) and available parameters.
- request jsonOnly visible if no input document is passed to the operator. The JSON contained here is then send as the request body to the REST service. Can be left empty when the DELETE request does not require a body.
- request xmlOnly visible if no input document is passed to the operator. The XML contained here is then send as the request body to the REST service. Can be left empty when the DELETE request does not require a body.
- request headersAdditional headers to include in the request. Can be for example used to log into protected services via an "Authorization" header.
- inject connection secretEnables the injection of a connection secret by replacing the identifier and secret placeholders defined in the selected connection entry with their respective values.
- connection entryThis parameter is only available when inject connection secret is enabled. This parameter is used to specify a repository location that represents a connection entry.
- fail on endpoint errorBy default, if a web service returns an error in the 4xx or 5xx range, this operator will fail. Sometimes however, some requests may be expected to fail, but the process should still continue (and for example return the error in the output document). In those cases, select this checkbox to keep the process going. Note that this operator will still fail if the call fails for technical reasons, e.g. the URL cannot be reached.
Tutorial Processes
DELETE JSON to a REST service with input document
This process deletes JSON at a REST service and returns the response from it as a document.
